<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::struc::shm::Builder&lt; Shm_arena &gt;::Config Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Public API.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1struc.html">struc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1struc_1_1shm.html">shm</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a></li><li class="navelem"><a class="el" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html">Config</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::struc::shm::Builder&lt; Shm_arena &gt;::Config Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Implements <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" title="Copy-ctible, copy-assignable, default-ctible type – informally, cheaply copyable and likely an aggreg...">Struct_builder::Config</a> sub-concept.  
 <a href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#details">More...</a></p>

<p><code>#include &lt;serializer.hpp&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac660f2e20310d2804f3dbcf8e9d1244d"><td class="memItemLeft" align="right" valign="top"><a id="ac660f2e20310d2804f3dbcf8e9d1244d" name="ac660f2e20310d2804f3dbcf8e9d1244d"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>Builder</b> = <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">shm::Builder</a>&lt; Shm_arena &gt;</td></tr>
<tr class="memdesc:ac660f2e20310d2804f3dbcf8e9d1244d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements concept API. <br /></td></tr>
<tr class="separator:ac660f2e20310d2804f3dbcf8e9d1244d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a4c287783d239663193a681aad8690dd4"><td class="memItemLeft" align="right" valign="top"><a id="a4c287783d239663193a681aad8690dd4" name="a4c287783d239663193a681aad8690dd4"></a>
flow::log::Logger *&#160;</td><td class="memItemRight" valign="bottom"><b>m_logger_ptr</b></td></tr>
<tr class="memdesc:a4c287783d239663193a681aad8690dd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logger to use for logging subsequently. <br /></td></tr>
<tr class="separator:a4c287783d239663193a681aad8690dd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab850e04c8a411941c75b74e7c6eccb36"><td class="memItemLeft" align="right" valign="top"><a id="ab850e04c8a411941c75b74e7c6eccb36" name="ab850e04c8a411941c75b74e7c6eccb36"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_top_builder_frame_prefix_sz</b></td></tr>
<tr class="memdesc:ab850e04c8a411941c75b74e7c6eccb36"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <code>struct</code> doc header. <br /></td></tr>
<tr class="separator:ab850e04c8a411941c75b74e7c6eccb36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae30cd8f4721bccd20ef5f195c332a960"><td class="memItemLeft" align="right" valign="top"><a id="ae30cd8f4721bccd20ef5f195c332a960" name="ae30cd8f4721bccd20ef5f195c332a960"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_top_builder_frame_postfix_sz</b></td></tr>
<tr class="memdesc:ae30cd8f4721bccd20ef5f195c332a960"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <code>struct</code> doc header. <br /></td></tr>
<tr class="separator:ae30cd8f4721bccd20ef5f195c332a960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca2f1b980653da86d533243f174107f3"><td class="memItemLeft" align="right" valign="top"><a id="aca2f1b980653da86d533243f174107f3" name="aca2f1b980653da86d533243f174107f3"></a>
<a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9bc898884381eebdb03f0dd9f74895de">Arena</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>m_arena</b></td></tr>
<tr class="memdesc:aca2f1b980653da86d533243f174107f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <code>struct</code> doc header. <br /></td></tr>
<tr class="separator:aca2f1b980653da86d533243f174107f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename Shm_arena&gt;<br />
struct ipc::transport::struc::shm::Builder&lt; Shm_arena &gt;::Config</div><p >Implements <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" title="Copy-ctible, copy-assignable, default-ctible type – informally, cheaply copyable and likely an aggreg...">Struct_builder::Config</a> sub-concept. </p>
<p >In this impl: The data members control <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">Builder</a>'s behavior as follows:</p>
<p ><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">Builder</a> ctor configured by <a class="el" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html" title="Implements Struct_builder::Config sub-concept.">Config</a> creates builder that shall SHM-allocate segments of internally determined sizes subsequently. The SHM provider is to be supplied to this ctor via <a class="el" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#aca2f1b980653da86d533243f174107f3" title="See struct doc header.">m_arena</a> arg; see class doc header for requirements and background. (The simplest available setup would let <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9bc898884381eebdb03f0dd9f74895de" title="Short-hand for Shm_arena template param.">Arena</a> = <a class="el" href="classipc_1_1shm_1_1classic_1_1Pool__arena.html" title="A SHM-classic interface around a single SHM pool with allocation-algorithm services by boost....">ipc::shm::classic::Pool_arena</a>; with <a class="el" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#aca2f1b980653da86d533243f174107f3" title="See struct doc header.">m_arena</a> = some pre-opened <code>Pool_arena</code>.)</p>
<p >This builder, like all builders in this context, produces a non-zero copy <em>top serialization</em>, in this case storing just a small handful of bits encoding the SHM handle to the true serialization which is SHM-stored. <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a7909a2d1e1d24037fb8af5338fffa783" title="Implements concept API.">Builder::emit_serialization()</a> will emit to you a top serialization to transmit to the recipient process over pipe-like IPC. This top serialization shall consist of 1 segment, and that segment shall be quite small &ndash; small enough to fit into any reasonable <a class="el" href="classipc_1_1transport_1_1Blob__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">Blob_sender</a> message. <em>If</em> framing is required &ndash; in the exact same sense as <a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#aeb6fcd8308642adbcb6edcd564375c88" title="See struct doc header.">Heap_fixed_builder::Config::m_frame_prefix_sz</a> and <code>m_frame_postfix_sz</code> &ndash; you may set either or both of those members to the appropriate non-zero values. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>transport/struc/shm/<a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html">serializer.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:23 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
